STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: HSPC-Organization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-organization

The "Organization" model describes an organization. A Provider Organization is a role played by an instance of this organization.

This profile was published on Tue, May 19, 2015 00:00+1000 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑ I0..*IdentifierIdentifies this organization across multiple systems
... active ?! S∑0..1booleanWhether the organization's record is still in active use
... type S ∑0..1CodeableConceptKind of organization
Binding: HSPC Organization Type (preferred)
... name ∑ I0..1stringName used for the organization
.... hspc-organization-HSPC-OrganizationNameUse 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-organization-HSPC-OrganizationNameUse
.... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... value 0..1Primitive value for string
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(QICore-Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... hspc-organization-primaryLanguage 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-organization-primaryLanguage
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

todo

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑ I0..*IdentifierIdentifies this organization across multiple systems
... active ?! S∑0..1booleanWhether the organization's record is still in active use
... type S ∑0..1CodeableConceptKind of organization
Binding: HSPC Organization Type (preferred)
... name ∑ I0..1stringName used for the organization
.... hspc-organization-HSPC-OrganizationNameUse 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-organization-HSPC-OrganizationNameUse
.... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... value 0..1Primitive value for string
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(QICore-Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... hspc-organization-primaryLanguage 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-organization-primaryLanguage
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Organization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Organization.typeHSPC Organization TypepreferredHSPC Organization Type
Organization.address.useAddressUserequiredAddressUse
Organization.address.typeAddressTyperequiredAddressType
Organization.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Organization.contact.purposeContactEntityTypeextensibleContactEntityType

H.??.3 Constraints

IdPathDetailsRequirements
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
.